/*
 *
 * Copyright (c) 2006-2020, Speedment, Inc. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); You may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at:
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */
package com.speedment.common.codegen.model;

import com.speedment.common.codegen.internal.model.ConstructorImpl;
import com.speedment.common.codegen.model.modifier.ConstructorModifier;
import com.speedment.common.codegen.model.modifier.Modifier;
import com.speedment.common.codegen.model.trait.*;

/**
 * A model that represents a constructor in code.
 * 
 * @author Emil Forslund
 * @since  2.0
 */
public interface Constructor
extends HasParent<HasConstructors<?>, Constructor>,
        HasImports<Constructor>,
        HasCopy<Constructor>,
        HasCall<Constructor>,
        HasGenerics<Constructor>,
        HasThrows<Constructor>,
        HasJavadoc<Constructor>,
        HasAnnotationUsage<Constructor>,
        HasFields<Constructor>,
        HasCode<Constructor>,
        ConstructorModifier<Constructor> {

    /**
     * Creates a new instance implementing this interface by using the default
     * implementation.

     * @return  the new instance
     */
    static Constructor of() {
        return new ConstructorImpl();
    }

    /**
     * Creates a new instance implementing this interface by using the default
     * implementation and setting the {@link Modifier#PUBLIC}-modifier.

     * @return  the new instance
     * @since   2.5
     */
    static Constructor newPublic() {
        return new ConstructorImpl().public_();
    }

    /**
     * Creates a new instance implementing this interface by using the default
     * implementation and setting the {@link Modifier#PRIVATE}-modifier.

     * @return  the new instance
     * @since   2.5
     */
    static Constructor newPrivate() {
        return new ConstructorImpl().private_();
    }

    /**
     * Creates a new instance implementing this interface by using the default
     * implementation and setting the {@link Modifier#PROTECTED}-modifier.

     * @return  the new instance
     * @since   2.5
     */
    static Constructor newProtected() {
        return new ConstructorImpl().protected_();
    }
}